Pular para o conteúdo principal

5.3 Cancelamento de boletos

Request

Request
mutation MarkToCancelBilling {
markToCancelBilling(
data: {
cancellationReason: BILLING_WRONG_VALUE
refId: "8e0c4a53-66cb-41b8-ab92-7be132437755"
}
) {
canceled
scheduled
billingId
}
}

Params

ParâmetroTipoDescrição
dataCancelBillingDataInput!Dados de inclusão da cobrança

Objeto CancelBillingDataInput

CampoTipoDescrição
auditDataAuditDataInputDados de auditoria do sistema integrado
cancellationDescriptionStringDescrição do motivo de cancelamento
cancellationReasonCancellationReasonMotivo de cancelamento
idIntId da cobrança
manualCancellationBooleanCancelamento manual
notesStringAnotação
refIdStringId de referência
scheduleCancellationIfNotRegisteredBooleanEm caso de falha ao tentar o cancelamento, o sistema irá marcar a cobrança para ser cancelada posteriormente

Response

Response
{
"data": {
"markToCancelBilling": {
"canceled": true,
"scheduled": false,
"billingId": null
}
}
}

Result

CampoTipoDescrição
markToCancelBillingCancelBillingResult!Dados de retorno do cancelamento da cobrança

Objeto CancelBillingResult

CampoTipoDescrição
billingIdIntId único da cobrança
canceledBoolean!Cobrança foi cancelada
scheduledBoolean!Cobrança foi agendada para ser cancelada após o registro